Zync SDK/zync.api.customer.models

Package-level declarations

Types

CustomerDetailResult

sealed class CustomerDetailResult

GetCustomersResult

sealed class GetCustomersResult

Result type for getting paginated customers list. Contains pagination metadata and partial data indicator.

ZyncContactNumber

data class ZyncContactNumber(val mobile: String?, val home: String?, val work: String?)

ZyncCustomer

data class ZyncCustomer(val uid: String, val firstName: String, val lastName: String?, val email: String?, val contactNo: ZyncContactNumber?, val noOfJobs: Int?, val companyName: String?, val organization: ZyncOrganization?, val timezone: String?, val category: ZyncCustomerCategory?, val billingAddress: ZyncAddress?, val address: ZyncAddress?, val allAddresses: List<ZyncAddress>?, val isActive: Boolean)

ZyncCustomerAccounts

data class ZyncCustomerAccounts(val lifetimeValue: Double, val receivables: Double, val credits: Double, val paymentTerm: ZyncPaymentTerm?, val taxGroup: ZyncTaxGroup?, val billingFrequency: ZyncCustomerBillingFrequency?, val tax: ZyncCustomerAccountsTax)

ZyncCustomerAccountsTax

data class ZyncCustomerAccountsTax(val taxEntityCode: String?)

ZyncCustomerBillingFrequency

data class ZyncCustomerBillingFrequency(val frequencyUid: String, val frequencyName: String)

ZyncCustomerCategory

data class ZyncCustomerCategory(val categoryId: String?, val categoryUid: String, val categoryName: String)

ZyncCustomerDetail

data class ZyncCustomerDetail(val customerUid: String, val firstName: String, val lastName: String?, val email: String?, val contactNo: ZyncContactNumber?, val timezone: String?, val companyName: String?, val description: String?, val noOfJobs: Int?, val isActive: Boolean, val organization: ZyncOrganization?, val category: ZyncCustomerCategory?, val address: ZyncAddress?, val billingAddress: ZyncAddress?, val allAddresses: List<ZyncAddress>, val tags: List<String>, val accounts: ZyncCustomerAccounts?, val slaDuration: ZyncSlaDuration?, val accountManager: ZyncUser?, val customFields: List<ZyncFormField>, val attachments: List<ZyncAttachment>, val priceList: ZyncPriceList?, val customerTax: ZyncCustomerTax?, val hasSla: Boolean, val hasCardOnFile: Boolean, val createdAt: String, val updatedAt: String?, val isSyncPending: Boolean)

Represents a comprehensive customer detail with all related information. This model follows the offline-first approach, providing immediate access to cached data.

ZyncCustomerSortAndFilter

data class ZyncCustomerSortAndFilter(val sortType: ZyncSortType = ZyncSortType.Ascending, val sortBy: ZyncCustomerSortBy = ZyncCustomerSortBy.DEFAULT, val keyword: String? = null, val filterCategory: String? = null, val jobRange: ZyncFilterJobRange? = null, val customerTags: List<String>? = null, val createdDateRange: ZyncFilterDateRange? = null, val createdByUser: ZyncFilterModule? = null, val customField: ZyncFilterByCustomField? = null, val isActive: Boolean? = null, val accountManager: ZyncFilterModule? = null, val organization: ZyncFilterModule? = null, val hasCardOnFile: Boolean? = null, val hasOrganization: Boolean? = null, val uids: List<String>? = null)

Comprehensive sorting and filtering options for customer queries. Provides a clean API for complex customer filtering and sorting operations.

ZyncCustomerSortBy

enum ZyncCustomerSortBy : Enum<ZyncCustomerSortBy>

Enum representing different sorting options for customer queries. Maps to backend sort field constants.

ZyncCustomerTax

data class ZyncCustomerTax(val isTaxExempt: Boolean, val taxEntityCode: String?)

Customer tax information with exemption status and entity code.

ZyncCustomerUpdateEvent

sealed class ZyncCustomerUpdateEvent

ZyncFilterJobRange

data class ZyncFilterJobRange(val fromCount: Int, val toCount: Int, val type: ZyncFilterJobRangeType)

Data class representing a job count range filter for customer queries. Used to filter customers by the number of jobs they have.

ZyncFilterJobRangeType

enum ZyncFilterJobRangeType : Enum<ZyncFilterJobRangeType>

Enum representing predefined job count ranges for customer filtering.

ZyncSlaDuration

data class ZyncSlaDuration(val minutes: Int, val hours: Int, val days: Int)

Customer SLA duration configuration with time-based limits. Uses single values matching Android implementation.